fix(typescript): map included .ts files in step output - #5685

Thanks for digging into this! Your read of the write/read mismatch is correct. Here’s a minimal browser-free config that reproduces it, with only this PR applied the Scenario Steps path is still wrong.

Working Repro

Browser-free, no network, ~1.1s. CodeceptJS 4.1.0 (latest on npm) with the one-line change from this PR hand-applied to lib/container.js. Same result on 4.0.8.

codecept.conf.js:

export const config = {
  tests: './tests/*Test.ts',
  helpers: { FakeHelper: { require: './fakeHelper.js' } },
  include: { fooPage: './pages/fooPage.ts' },
  require: ['tsx/cjs'],
  name: 'ts-step-paths-repro',
};

fakeHelper.js — avoids needing a browser at all:

import Helper from 'codeceptjs/lib/helper';

export default class FakeHelper extends Helper {
  doThing(label) { return label; }
  failNow(message) { throw new Error(message); }
}

pages/fooPage.ts:

export {};
const { I } = inject();

export default {
  open() {
    I.doThing('called from a .ts page object under include');
  },
};

tests/fooTest.ts — the failing step is what makes the Scenario Steps block print:

Feature('ts step paths');

Scenario('reports page object step path', ({ I, fooPage }) => {
  fooPage.open();
  I.failNow('deliberate failure so Scenario Steps is printed');
});

Result matrix

Neither change is sufficient alone, both are necessary.

Defect

Even with this PR’s change applied (hand-patched into lib/container.js on 4.1.0), Scenario Steps still report .temp.mjs. Instrumenting Step.line() shows why:

[DEBUG] line to match: "at Object.open (file://./pages/fooPage.74609.ryob11cp.temp.mjs:4:11)"
[DEBUG] mapping present: true size: 1
[DEBUG]   entry mjs: "/abs/path/to/pages/fooPage.74609.ryob11cp.temp.mjs" -> matched: false

The mapping entry now exists, your change works, but the lookup still misses.

Step.line() shortens absolute paths to . before it looks them up in the mapping. The mapping’s keys are still absolute (transpileTypeScript stores them that way), so after shortening, line.includes(mjsFile) never finds a match.

Doing the mapping first, then shortening, seems to fix it:

   line() {
     const lines = this.stack.split('\n')
     if (lines[STACK_LINE]) {
-      let line = lines[STACK_LINE].trim()
-        .replace(store.codeceptDir || '', '.')
-        .trim()
+      let line = lines[STACK_LINE].trim()

-      // Map .temp.mjs back to original .ts files using container's tsFileMapping
+      // Map .temp.mjs back to original .ts files using container's tsFileMapping.
+      // The mapping holds absolute paths, so this must run before codeceptDir is
+      // shortened to '.', or the lookup can never match.
       const fileMapping = store.tsFileMapping
       if (line.includes('.temp.mjs') && fileMapping) {
         for (const [tsFile, mjsFile] of fileMapping.entries()) {
           if (line.includes(mjsFile)) {
             line = line.replace(mjsFile, tsFile)
             break
           }
         }
       }

-      return line
+      return line.replace(store.codeceptDir || '', '.').trim()
     }
     return ''
   }

Non-mapped step lines still shorten the same way, eg at Test.<anonymous> (./tests/fooTest.ts:7:5).

Even when mapping works, include steps still show file://./pages/fooPage.ts rather than ./pages/fooPage.ts, because shortening leaves the file:// scheme.

Line numbers are still wrong (separate issue)

#5675 also mentioned wrong line numbers, and that part is not fixed by either change. Green output reports ./pages/fooPage.ts:4:11, but I.doThing is at line 6, column 9, the numbers are still the transpiled .mjs's, off by the stripped export {} and blank line.

fileMapping is file-level only, so no path-substitution fix can recover line numbers. That needs line-preserving transpilation or real source maps. Worth splitting out rather than closing #5675 as fully fixed.

Thanks for the detailed repro and result matrix. You're right: this PR populates the mapping, but Step.line() shortens the absolute path before the lookup, so the absolute .temp.mjs key can never match.

I'll update this PR to apply the mapping before codeceptDir normalization, remove the leftover file:// prefix, and add the browser-free regression you outlined. I'll keep the incorrect line numbers separate because file-level mapping cannot recover source positions. This PR should only claim to restore the original .ts path.